Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hub: add image library section #21485

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

craig-osterhout
Copy link
Contributor

@craig-osterhout craig-osterhout commented Nov 22, 2024

Description

  • Added "Container image library" section in Docker Hub manual and started adding concepts.
    • Added section about search and all the filters
    • Added section about catalogs
    • Moved mirroring topic inside
  • Updated Hub landing page
  • Moved "Trusted content" into Repositories>Manage (for publishers) and Library (for consumers).

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/
https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/
https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/search/
https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/catalogs/
https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/image-library/trusted-content/

https://deploy-preview-21485--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/

Related issues or tickets

ENGDOCS-2352

Reviews

  • Editorial review
  • Product review

Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit ddc3189
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/675b5f19fdfe5400077eccdc
😎 Deploy Preview https://deploy-preview-21485--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added area/hub Issue affects Docker Hub area/tests labels Nov 22, 2024
@github-actions github-actions bot added area/build Relates to Dockerfiles or docker build command area/security area/get-started Relates to get started and onboarding docs area/subscription Relates to Docker pricing and subscription labels Dec 3, 2024
@craig-osterhout craig-osterhout force-pushed the hub-library branch 2 times, most recently from 79e1e17 to 169f2f0 Compare December 3, 2024 22:39
Copy link
Collaborator

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good!

content/manuals/docker-hub/image-library/_index.md Outdated Show resolved Hide resolved
demos provide a hands-on way to explore AI tools and frameworks, making it
easier to understand how they can be integrated into real-world applications.
- Models: Pre-trained AI models for tasks like text generation,
natural language processing (NLP), and conversational AI. These models
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This deals with the vale nag

Suggested change
natural language processing (NLP), and conversational AI. These models
Natural Language Processing (NLP), and conversational AI. These models

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dvdksn Fixing it. But, is that a vale limitation, or do we consider all terms to be proper nouns if they have an acronym?

For example in this particular case, Wikipedia considers NLP not a proper noun https://en.wikipedia.org/wiki/Natural_language_processing
And Microsoft style guide says don't capitalize unless a proper noun, https://learn.microsoft.com/en-us/style-guide/acronyms#lowercase-the-spelled-out-term

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's how our rule for these acronyms is configured:

second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{2,5})\)'

We only consider an acronym spelled out if it's preceded by a Proper Noun. It doesn't actually check that that the acronym and the proper nouns are the same. (In other words, Some Random Word (FOO) would be considered valid by this vale rule.)

I don't think there's a way to make this rule smarter with the built-in vale styles. But we might be able to write a tengo script. I can take a quick look. Otherwise, I think our alternatives are:

  • Use proper nouns when spelling out an acronym anyway (I don't mind this rule)
  • Don't check for unexpanded acronyms at all
  • Manually ignore this rule: <!-- vale Docker.Acronyms = NO -->

content/manuals/docker-hub/image-library/catalogs.md Outdated Show resolved Hide resolved
content/manuals/docker-hub/image-library/catalogs.md Outdated Show resolved Hide resolved
Signed-off-by: Craig <[email protected]>
Copy link
Collaborator

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Relates to Dockerfiles or docker build command area/get-started Relates to get started and onboarding docs area/hub Issue affects Docker Hub area/security area/subscription Relates to Docker pricing and subscription area/tests status/review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants